///********************************************************************
///* Copyright © 2012 fishr (fishr.flash@gmail.com)  
///********************************************************************


package su.fishr.social_network.OK.uploadV2 
{
	import flash.display.Bitmap;
	import flash.utils.ByteArray;
	
	   

	/**
	 * 	Вспомогательный класс, cлужит для формирования
	 * структуры данных (непосредственной и дополнительной
	 * информации о фотографии или изобаржении) для передачи
	 * в параметрах инициализации объекта <a href="UploaderPhotoV2.html">UploaderPhotoV2</a>
	 * 
	 * 
	 * @playerversion          Flash 10
	 * @langversion            3.0
	 * @author                 fishr
	 * @created                03.06.2012 2:01
	 * @since                  03.06.2012 2:01
	 */
	public  class DataPhoto
	{
	/**-------------------------------------------------------------------------------
	* 
	*	   						V A R I A B L E ' S 	
	* 
	* --------------------------------------------------------------------------------
	*/
	//{
		static private const AUTHOR:String = "fishr (fishr.flash@gmail.com)";
		/**
		 *  Непосредственно само изображение ( фотография) представленное либо объектом
		 *  <code>Bitmap</code> или <code>BitmapData</code>, или бинарным массивом ( <code>ByteArray</code> )
		 * 	- резултатом кодирования объекта изображения в формат jpeg.
		 * 
		 */
		public var photoValue:Object;
		/**
		 *  Функция обратного вызова, имеет один параметр вызова типа <code>String</code>.
		 * Ей возвращается резульат загрузки фотографий - одно из строковых значений описаных
		 * константами класса <code>UploaderPhotoV2</code>
		 */
		public var callback:Function;
		/**
		 *  Не обязательное значение, комментарий добавляемый к фотографии
		 * загруженной в альбом пользователя.
		 */
		public var comment:String = "";
		/**
		 * Имя файла фотографии ( вне зависимости от этого значения API Odnoklassniki 
		 * устанавливает имя файла "getImage" )
		 */
		public var photoName:String;
		
	//}
	
	/**-------------------------------------------------------------------------------
	* 
	*								P U B L I C 	
	* 
	* --------------------------------------------------------------------------------
	*/
	//{
		/**
		 * 		конструктор класса
		 * 
		 * @param	callback функция в которую будет возвращен результат работы плагина
		 *          представляющий собой строку - одно из значений констант класса <code>UploaderPhotoV2</code>
		 * @param	photo непосредственно само изображение ( фотография) представленное либо объектом
		 *          <code>Bitmap</code>, <code>BitmapData</code> или бинарным массивом ( <code>ByteArray</code> )
		 * 			- резултатом кодирования объекта изображения в формат jpeg.
		 * @param	commentary необязательное строковое значение - подпись под фотогрфией в альбоме
		 * @param	name имя файла фотографии ( вне зависимости от этого значения API Odnoklassniki 
		 *               устанавливает имя файла "getImage" )
		 * 
		 * @see UploaderPhotoV2#UploaderPhotoV2()
		 */
		public function DataPhoto(callbackFunction:Function, photo:Object, commentary:String = "", name:String = "")
		{
			init( callbackFunction, photo, commentary, name );
			
		}
	/**-------------------------------------------------------------------------------
	* 
	*								P R I V A T E 	
	* 
	* --------------------------------------------------------------------------------
	*/			
		private function init(callbackFunction:Function, photo:Object, commentary:String = "", name:String = ""):void
		{
			callback = callbackFunction;
			comment = commentary;
			photoName = name;
			photoValue = photo;
		}
		
	//}
	}

}